Skip to main content

swagger_client

SwaggerClient - the Ruby gem for the Estuary API

This is the API for the Estuary application.

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.ruby.RubyClientCodegen For more information, please visit https://docs.estuary.tech/feedback

Installation

Build a gem

To build the Ruby code into a gem:

gem build swagger_client.gemspec

Then either install the gem locally:

gem install ./swagger_client-1.0.0.gem

(for development, run gem install --dev ./swagger_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'swagger_client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'swagger_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'swagger_client'
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::AdminApi.new

begin
#Get all miners
result = api_instance.admin_miners_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling AdminApi->admin_miners_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::AdminApi.new
body = ['body_example'] # Array<String> | Peer ids


begin
#Remove peers on Peering Service
result = api_instance.admin_peering_peers_delete(body)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling AdminApi->admin_peering_peers_delete: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::AdminApi.new

begin
#List all Peering peers
result = api_instance.admin_peering_peers_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling AdminApi->admin_peering_peers_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::AdminApi.new
body = [SwaggerClient::PeeringPeeringPeer.new] # Array<PeeringPeeringPeer> | Peering Peer array


begin
#Add peers on Peering Service
result = api_instance.admin_peering_peers_post(body)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling AdminApi->admin_peering_peers_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::AdminApi.new

begin
#Start Peering
result = api_instance.admin_peering_start_post
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling AdminApi->admin_peering_start_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::AdminApi.new

begin
#Check Peering Status
result = api_instance.admin_peering_status_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling AdminApi->admin_peering_status_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::AdminApi.new

begin
#Stop Peering
result = api_instance.admin_peering_stop_post
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling AdminApi->admin_peering_stop_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::AdminApi.new

begin
#Get systems(estuary/shuttle) config
result = api_instance.admin_system_config_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling AdminApi->admin_system_config_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::AdminApi.new

begin
#Get all users
result = api_instance.admin_users_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling AdminApi->admin_users_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::AutoretrieveApi.new
addresses = 'addresses_example' # String |
pub_key = 'pub_key_example' # String |


begin
#Register autoretrieve server
result = api_instance.admin_autoretrieve_init_post(addresses, pub_key)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling AutoretrieveApi->admin_autoretrieve_init_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::AutoretrieveApi.new

begin
#List autoretrieve servers
result = api_instance.admin_autoretrieve_list_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling AutoretrieveApi->admin_autoretrieve_list_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::AutoretrieveApi.new
token = 'token_example' # String | Autoretrieve's auth token


begin
#Marks autoretrieve server as up
result = api_instance.autoretrieve_heartbeat_post(token)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling AutoretrieveApi->autoretrieve_heartbeat_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::CollectionsApi.new
coluuid = 'coluuid_example' # String | coluuid


begin
#Produce a CID of the collection contents
result = api_instance.collections_coluuid_commit_post(coluuid)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling CollectionsApi->collections_coluuid_commit_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::CollectionsApi.new
body = SwaggerClient::ApiDeleteContentFromCollectionBody.new # ApiDeleteContentFromCollectionBody | Variable to use when filtering for files (must be either 'path' or 'content_id')
coluuid = 'coluuid_example' # String | Collection ID


begin
#Deletes a content from a collection
result = api_instance.collections_coluuid_contents_delete(body, coluuid)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling CollectionsApi->collections_coluuid_contents_delete: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::CollectionsApi.new
coluuid = 'coluuid_example' # String | Collection ID


begin
#Deletes a collection
result = api_instance.collections_coluuid_delete(coluuid)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling CollectionsApi->collections_coluuid_delete: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::CollectionsApi.new
coluuid = 'coluuid_example' # String | coluuid
opts = {
dir: 'dir_example' # String | Directory
}

begin
#Get contents in a collection
result = api_instance.collections_coluuid_get(coluuid, opts)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling CollectionsApi->collections_coluuid_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::CollectionsApi.new
body = [56] # Array<Integer> | Content IDs to add to collection
coluuid = 'coluuid_example' # String | Collection UUID
opts = {
dir: 'dir_example', # String | Directory
overwrite: 'overwrite_example' # String | Overwrite conflicting files
}

begin
#Add contents to a collection
result = api_instance.collections_coluuid_post(body, coluuid, opts)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling CollectionsApi->collections_coluuid_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::CollectionsApi.new
coluuid = 'coluuid_example' # String | Collection ID
content = 'content_example' # String | Content
opts = {
dir: 'dir_example', # String | Directory inside collection
overwrite: 'overwrite_example' # String | Overwrite file if already exists in path
}

begin
#Add a file to a collection
result = api_instance.collections_fs_add_post(coluuid, content, opts)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling CollectionsApi->collections_fs_add_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::CollectionsApi.new

begin
#List all collections
result = api_instance.collections_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling CollectionsApi->collections_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::CollectionsApi.new
body = SwaggerClient::ApiCreateCollectionBody.new # ApiCreateCollectionBody | Collection name and description


begin
#Create a new collection
result = api_instance.collections_post(body)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling CollectionsApi->collections_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::ContentApi.new
code = 'code_example' # String | Invite code to be created


begin
#Create an Estuary invite
result = api_instance.admin_invites_code_post(code)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling ContentApi->admin_invites_code_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::ContentApi.new

begin
#Get Estuary invites
result = api_instance.admin_invites_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling ContentApi->admin_invites_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::ContentApi.new
body = 'body_example' # String | Car
opts = {
ignore_dupes: 'ignore_dupes_example', # String | Ignore Dupes
filename: 'filename_example' # String | Filename
}

begin
#Add Car object
result = api_instance.content_add_car_post(body, opts)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling ContentApi->content_add_car_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::ContentApi.new
body = SwaggerClient::TypesIpfsPin.new # TypesIpfsPin | IPFS Body
opts = {
ignore_dupes: 'ignore_dupes_example', # String | Ignore Dupes
overwrite: 'overwrite_example' # String | Overwrite conflicting files in collections
}

begin
#Add IPFS object
result = api_instance.content_add_ipfs_post(body, opts)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling ContentApi->content_add_ipfs_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::ContentApi.new
data = 'data_example' # String |
filename = 'filename_example' # String |
opts = {
coluuid: 'coluuid_example', # String | Collection UUID
replication: 56, # Integer | Replication value
ignore_dupes: 'ignore_dupes_example', # String | Ignore Dupes true/false
overwrite: 'overwrite_example', # String | Overwrite files with the same path on same collection
lazy_provide: 'lazy_provide_example', # String | Lazy Provide true/false
dir: 'dir_example' # String | Directory
}

begin
#Add new content
result = api_instance.content_add_post(data, filename, opts)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling ContentApi->content_add_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::ContentApi.new
content = 'content_example' # String | Content ID


begin
#Get aggregated content stats
result = api_instance.content_aggregated_content_get(content)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling ContentApi->content_aggregated_content_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::ContentApi.new
_begin = '_begin_example' # String | Begin
duration = 'duration_example' # String | Duration
all = 'all_example' # String | All


begin
#Get all deals for a user
result = api_instance.content_all_deals_get(_begin, duration, all)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling ContentApi->content_all_deals_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::ContentApi.new
content = 'content_example' # String | Content ID


begin
#Get content bandwidth
result = api_instance.content_bw_usage_content_get(content)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling ContentApi->content_bw_usage_content_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::ContentApi.new
limit = 'limit_example' # String | limit
offset = 'offset_example' # String | offset


begin
#Get user contents
result = api_instance.content_contents_get(limit, offset)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling ContentApi->content_contents_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::ContentApi.new
body = SwaggerClient::UtilContentCreateBody.new # UtilContentCreateBody | Content
opts = {
ignore_dupes: 'ignore_dupes_example' # String | Ignore Dupes
}

begin
#Add a new content
result = api_instance.content_create_post(body, opts)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling ContentApi->content_create_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::ContentApi.new
opts = {
limit: 56, # Integer | Limit
offset: 56 # Integer | Offset
}

begin
#Content with deals
result = api_instance.content_deals_get(opts)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling ContentApi->content_deals_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::ContentApi.new
datacid = 'datacid_example' # String | Data CID


begin
#Ensure Replication
result = api_instance.content_ensure_replication_datacid_get(datacid)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling ContentApi->content_ensure_replication_datacid_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::ContentApi.new
content = 'content_example' # String | Content ID


begin
#List all failures for a content
result = api_instance.content_failures_content_get(content)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling ContentApi->content_failures_content_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::ContentApi.new
id = 56 # Integer | Content ID


begin
#Content
result = api_instance.content_id_get(id)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling ContentApi->content_id_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::ContentApi.new

begin
#List all pinned content
result = api_instance.content_list_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling ContentApi->content_list_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::ContentApi.new

begin
#Get staging zone for user, excluding its contents
result = api_instance.content_staging_zones_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling ContentApi->content_staging_zones_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::ContentApi.new
staging_zone = 56 # Integer | Staging Zone Content ID
limit = 'limit_example' # String | limit
offset = 'offset_example' # String | offset


begin
#Get contents for a staging zone
result = api_instance.content_staging_zones_staging_zone_contents_get(staging_zone, limit, offset)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling ContentApi->content_staging_zones_staging_zone_contents_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::ContentApi.new
staging_zone = 56 # Integer | Staging Zone Content ID


begin
#Get staging zone without its contents field populated
result = api_instance.content_staging_zones_staging_zone_get(staging_zone)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling ContentApi->content_staging_zones_staging_zone_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::ContentApi.new
limit = 'limit_example' # String | limit
offset = 'offset_example' # String | offset


begin
#Get content statistics
result = api_instance.content_stats_get(limit, offset)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling ContentApi->content_stats_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::ContentApi.new
id = 56 # Integer | Content ID


begin
#Content Status
result = api_instance.content_status_id_get(id)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling ContentApi->content_status_id_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::DealsApi.new
body = SwaggerClient::ApiEstimateDealBody.new # ApiEstimateDealBody | The size of the deal in bytes, the replication factor, and the duration of the deal in blocks


begin
#Estimate the cost of a deal
result = api_instance.deal_estimate_post(body)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deal_estimate_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::DealsApi.new
dealid = 56 # Integer | Deal ID


begin
#Get Deal Info
result = api_instance.deal_info_dealid_get(dealid)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deal_info_dealid_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::DealsApi.new
propcid = 'propcid_example' # String | Proposal CID


begin
#Get Proposal
result = api_instance.deal_proposal_propcid_get(propcid)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deal_proposal_propcid_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::DealsApi.new
miner = 'miner_example' # String | CID


begin
#Query Ask
result = api_instance.deal_query_miner_get(miner)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deal_query_miner_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::DealsApi.new
propcid = 'propcid_example' # String | PropCid


begin
#Get Deal Status by PropCid
result = api_instance.deal_status_by_proposal_propcid_get(propcid)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deal_status_by_proposal_propcid_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::DealsApi.new
miner = 'miner_example' # String | Miner
propcid = 'propcid_example' # String | Proposal CID


begin
#Deal Status
result = api_instance.deal_status_miner_propcid_get(miner, propcid)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deal_status_miner_propcid_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::DealsApi.new

begin
#Transfer In Progress
result = api_instance.deal_transfer_in_progress_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deal_transfer_in_progress_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::DealsApi.new
body = SwaggerClient::ApiChannelIDParam.new # ApiChannelIDParam | Channel ID


begin
#Transfer Status
result = api_instance.deal_transfer_status_post(body)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deal_transfer_status_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::DealsApi.new

begin
#Get storage failures for user
result = api_instance.deals_failures_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deals_failures_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::DealsApi.new
body = 'body_example' # String | Deal Request
miner = 'miner_example' # String | Miner


begin
#Make Deal
result = api_instance.deals_make_miner_post(body, miner)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deals_make_miner_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::DealsApi.new
deal = 56 # Integer | Deal ID


begin
#Get Deal Status
result = api_instance.deals_status_deal_get(deal)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->deals_status_deal_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::DealsApi.new

begin
#Get storage failures
result = api_instance.public_deals_failures_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->public_deals_failures_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::DealsApi.new
miner = 'miner_example' # String | CID


begin
#Query Ask
result = api_instance.public_miners_storage_query_miner_get(miner)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DealsApi->public_miners_storage_query_miner_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::DefaultApi.new

begin
#Fetch viewer details
result = api_instance.viewer_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling DefaultApi->viewer_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::MetricsApi.new

begin
#Get deal metrics
result = api_instance.public_metrics_deals_on_chain_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling MetricsApi->public_metrics_deals_on_chain_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::MinerApi.new
miner = 'miner_example' # String | Miner claim message


begin
#Get Claim Miner Message
result = api_instance.miner_claim_miner_get(miner)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling MinerApi->miner_claim_miner_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::MinerApi.new
body = SwaggerClient::MinerClaimMinerBody.new # MinerClaimMinerBody | Claim Miner Body


begin
#Claim Miner
result = api_instance.miner_claim_post(body)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling MinerApi->miner_claim_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::MinerApi.new
body = SwaggerClient::MinerMinerSetInfoParams.new # MinerMinerSetInfoParams | Miner set info params
miner = 'miner_example' # String | Miner to set info for


begin
#Set Miner Info
result = api_instance.miner_set_info_miner_put(body, miner)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling MinerApi->miner_set_info_miner_put: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::MinerApi.new
body = SwaggerClient::MinerSuspendMinerBody.new # MinerSuspendMinerBody | Suspend Miner Body
miner = 'miner_example' # String | Miner to suspend


begin
#Suspend Miner
result = api_instance.miner_suspend_miner_post(body, miner)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling MinerApi->miner_suspend_miner_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::MinerApi.new
miner = 'miner_example' # String | Miner to unsuspend


begin
#Unuspend Miner
result = api_instance.miner_unsuspend_miner_put(miner)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling MinerApi->miner_unsuspend_miner_put: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::MinerApi.new
miner = 'miner_example' # String | Filter by miner
opts = {
ignore_failed: 'ignore_failed_example' # String | Ignore Failed
}

begin
#Get all miners deals
result = api_instance.public_miners_deals_miner_get(miner, opts)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling MinerApi->public_miners_deals_miner_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::MinerApi.new
miner = 'miner_example' # String | Filter by miner


begin
#Get miner stats
result = api_instance.public_miners_stats_miner_get(miner)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling MinerApi->public_miners_stats_miner_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::NetApi.new

begin
#Get all miners
result = api_instance.admin_miners_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling NetApi->admin_miners_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::NetApi.new
miner = 'miner_example' # String | Filter by miner


begin
#Get all miners
result = api_instance.public_miners_failures_miner_get(miner)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling NetApi->public_miners_failures_miner_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::NetApi.new

begin
#Net Addrs
result = api_instance.public_net_addrs_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling NetApi->public_net_addrs_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::NetApi.new

begin
#Net Peers
result = api_instance.public_net_peers_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling NetApi->public_net_peers_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PinningApi.new

begin
#List all pin status objects
result = api_instance.pinning_pins_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PinningApi->pinning_pins_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PinningApi.new
pinid = 'pinid_example' # String | Pin ID


begin
#Delete a pinned object
api_instance.pinning_pins_pinid_delete(pinid)
rescue SwaggerClient::ApiError => e
puts "Exception when calling PinningApi->pinning_pins_pinid_delete: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PinningApi.new
pinid = 'pinid_example' # String | cid


begin
#Get a pin status object
result = api_instance.pinning_pins_pinid_get(pinid)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PinningApi->pinning_pins_pinid_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PinningApi.new
body = SwaggerClient::TypesIpfsPin.new # TypesIpfsPin | New pin
pinid = 'pinid_example' # String | Pin ID to be replaced


begin
#Replace a pinned object
result = api_instance.pinning_pins_pinid_post(body, pinid)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PinningApi->pinning_pins_pinid_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PinningApi.new
body = SwaggerClient::TypesIpfsPin.new # TypesIpfsPin | Pin Body {cid:cid, name:name}
opts = {
ignore_dupes: 'ignore_dupes_example', # String | Ignore Dupes
overwrite: 'overwrite_example' # String | Overwrite conflicting files in collections
}

begin
#Add and pin object
result = api_instance.pinning_pins_post(body, opts)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PinningApi->pinning_pins_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new
cid = 'cid_example' # String | Cid


begin
#Get Full Content by Cid
api_instance.get_cid_get(cid)
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->get_cid_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new
cid = 'cid_example' # String | Cid


begin
#Get Content by Cid
result = api_instance.public_by_cid_cid_get(cid)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->public_by_cid_cid_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new

begin
#Get public node info
result = api_instance.public_info_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->public_info_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new

begin
#Get deal metrics
result = api_instance.public_metrics_deals_on_chain_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->public_metrics_deals_on_chain_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new
miner = 'miner_example' # String | Filter by miner
opts = {
ignore_failed: 'ignore_failed_example' # String | Ignore Failed
}

begin
#Get all miners deals
result = api_instance.public_miners_deals_miner_get(miner, opts)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->public_miners_deals_miner_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new
miner = 'miner_example' # String | Filter by miner


begin
#Get all miners
result = api_instance.public_miners_failures_miner_get(miner)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->public_miners_failures_miner_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new
miner = 'miner_example' # String | Filter by miner


begin
#Get miner stats
result = api_instance.public_miners_stats_miner_get(miner)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->public_miners_stats_miner_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new

begin
#Net Addrs
result = api_instance.public_net_addrs_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->public_net_addrs_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new

begin
#Net Peers
result = api_instance.public_net_peers_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->public_net_peers_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::PublicApi.new

begin
#Public stats
result = api_instance.public_stats_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling PublicApi->public_stats_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::UserApi.new

begin
#Get API keys for a user
result = api_instance.user_api_keys_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling UserApi->user_api_keys_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::UserApi.new
key_or_hash = 'key_or_hash_example' # String | Key or Hash


begin
#Revoke a User API Key.
result = api_instance.user_api_keys_key_or_hash_delete(key_or_hash)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling UserApi->user_api_keys_key_or_hash_delete: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::UserApi.new
opts = {
expiry: 'expiry_example', # String | Expiration - Expiration - Valid time units are ns, us (or µs), ms, s, m, h. for example 300h
perms: 'perms_example' # String | Permissions -- currently unused
}

begin
#Create API keys for a user
result = api_instance.user_api_keys_post(opts)
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling UserApi->user_api_keys_post: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::UserApi.new

begin
#Export user data
result = api_instance.user_export_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling UserApi->user_export_get: #{e}"
end
# Setup authorization
SwaggerClient.configure do |config|
# Configure API key authorization: bearerAuth
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SwaggerClient::UserApi.new

begin
#Get stats for the current user
result = api_instance.user_stats_get
p result
rescue SwaggerClient::ApiError => e
puts "Exception when calling UserApi->user_stats_get: #{e}"
end

Documentation for API Endpoints

All URIs are relative to //api.estuary.tech/

ClassMethodHTTP requestDescription
SwaggerClient::AdminApiadmin_miners_getGET /admin/miners/Get all miners
SwaggerClient::AdminApiadmin_peering_peers_deleteDELETE /admin/peering/peersRemove peers on Peering Service
SwaggerClient::AdminApiadmin_peering_peers_getGET /admin/peering/peersList all Peering peers
SwaggerClient::AdminApiadmin_peering_peers_postPOST /admin/peering/peersAdd peers on Peering Service
SwaggerClient::AdminApiadmin_peering_start_postPOST /admin/peering/startStart Peering
SwaggerClient::AdminApiadmin_peering_status_getGET /admin/peering/statusCheck Peering Status
SwaggerClient::AdminApiadmin_peering_stop_postPOST /admin/peering/stopStop Peering
SwaggerClient::AdminApiadmin_system_config_getGET /admin/system/configGet systems(estuary/shuttle) config
SwaggerClient::AdminApiadmin_users_getGET /admin/usersGet all users
SwaggerClient::AutoretrieveApiadmin_autoretrieve_init_postPOST /admin/autoretrieve/initRegister autoretrieve server
SwaggerClient::AutoretrieveApiadmin_autoretrieve_list_getGET /admin/autoretrieve/listList autoretrieve servers
SwaggerClient::AutoretrieveApiautoretrieve_heartbeat_postPOST /autoretrieve/heartbeatMarks autoretrieve server as up
SwaggerClient::CollectionsApicollections_coluuid_commit_postPOST /collections/{coluuid}/commitProduce a CID of the collection contents
SwaggerClient::CollectionsApicollections_coluuid_contents_deleteDELETE /collections/{coluuid}/contentsDeletes a content from a collection
SwaggerClient::CollectionsApicollections_coluuid_deleteDELETE /collections/{coluuid}Deletes a collection
SwaggerClient::CollectionsApicollections_coluuid_getGET /collections/{coluuid}Get contents in a collection
SwaggerClient::CollectionsApicollections_coluuid_postPOST /collections/{coluuid}Add contents to a collection
SwaggerClient::CollectionsApicollections_fs_add_postPOST /collections/fs/addAdd a file to a collection
SwaggerClient::CollectionsApicollections_getGET /collections/List all collections
SwaggerClient::CollectionsApicollections_postPOST /collections/Create a new collection
SwaggerClient::ContentApiadmin_invites_code_postPOST /admin/invites/{code}Create an Estuary invite
SwaggerClient::ContentApiadmin_invites_getGET /admin/invitesGet Estuary invites
SwaggerClient::ContentApicontent_add_car_postPOST /content/add-carAdd Car object
SwaggerClient::ContentApicontent_add_ipfs_postPOST /content/add-ipfsAdd IPFS object
SwaggerClient::ContentApicontent_add_postPOST /content/addAdd new content
SwaggerClient::ContentApicontent_aggregated_content_getGET /content/aggregated/{content}Get aggregated content stats
SwaggerClient::ContentApicontent_all_deals_getGET /content/all-dealsGet all deals for a user
SwaggerClient::ContentApicontent_bw_usage_content_getGET /content/bw-usage/{content}Get content bandwidth
SwaggerClient::ContentApicontent_contents_getGET /content/contentsGet user contents
SwaggerClient::ContentApicontent_create_postPOST /content/createAdd a new content
SwaggerClient::ContentApicontent_deals_getGET /content/dealsContent with deals
SwaggerClient::ContentApicontent_ensure_replication_datacid_getGET /content/ensure-replication/{datacid}Ensure Replication
SwaggerClient::ContentApicontent_failures_content_getGET /content/failures/{content}List all failures for a content
SwaggerClient::ContentApicontent_id_getGET /content/{id}Content
SwaggerClient::ContentApicontent_list_getGET /content/listList all pinned content
SwaggerClient::ContentApicontent_staging_zones_getGET /content/staging-zonesGet staging zone for user, excluding its contents
SwaggerClient::ContentApicontent_staging_zones_staging_zone_contents_getGET /content/staging-zones/{staging_zone}/contentsGet contents for a staging zone
SwaggerClient::ContentApicontent_staging_zones_staging_zone_getGET /content/staging-zones/{staging_zone}Get staging zone without its contents field populated
SwaggerClient::ContentApicontent_stats_getGET /content/statsGet content statistics
SwaggerClient::ContentApicontent_status_id_getGET /content/status/{id}Content Status
SwaggerClient::DealsApideal_estimate_postPOST /deal/estimateEstimate the cost of a deal
SwaggerClient::DealsApideal_info_dealid_getGET /deal/info/{dealid}Get Deal Info
SwaggerClient::DealsApideal_proposal_propcid_getGET /deal/proposal/{propcid}Get Proposal
SwaggerClient::DealsApideal_query_miner_getGET /deal/query/{miner}Query Ask
SwaggerClient::DealsApideal_status_by_proposal_propcid_getGET /deal/status-by-proposal/{propcid}Get Deal Status by PropCid
SwaggerClient::DealsApideal_status_miner_propcid_getGET /deal/status/{miner}/{propcid}Deal Status
SwaggerClient::DealsApideal_transfer_in_progress_getGET /deal/transfer/in-progressTransfer In Progress
SwaggerClient::DealsApideal_transfer_status_postPOST /deal/transfer/statusTransfer Status
SwaggerClient::DealsApideals_failures_getGET /deals/failuresGet storage failures for user
SwaggerClient::DealsApideals_make_miner_postPOST /deals/make/{miner}Make Deal
SwaggerClient::DealsApideals_status_deal_getGET /deals/status/{deal}Get Deal Status
SwaggerClient::DealsApipublic_deals_failures_getGET /public/deals/failuresGet storage failures
SwaggerClient::DealsApipublic_miners_storage_query_miner_getGET /public/miners/storage/query/{miner}Query Ask
SwaggerClient::DefaultApiviewer_getGET /viewerFetch viewer details
SwaggerClient::MetricsApipublic_metrics_deals_on_chain_getGET /public/metrics/deals-on-chainGet deal metrics
SwaggerClient::MinerApiminer_claim_miner_getGET /miner/claim/{miner}Get Claim Miner Message
SwaggerClient::MinerApiminer_claim_postPOST /miner/claimClaim Miner
SwaggerClient::MinerApiminer_set_info_miner_putPUT /miner/set-info/{miner}Set Miner Info
SwaggerClient::MinerApiminer_suspend_miner_postPOST /miner/suspend/{miner}Suspend Miner
SwaggerClient::MinerApiminer_unsuspend_miner_putPUT /miner/unsuspend/{miner}Unuspend Miner
SwaggerClient::MinerApipublic_miners_deals_miner_getGET /public/miners/deals/{miner}Get all miners deals
SwaggerClient::MinerApipublic_miners_stats_miner_getGET /public/miners/stats/{miner}Get miner stats
SwaggerClient::NetApiadmin_miners_getGET /admin/miners/Get all miners
SwaggerClient::NetApipublic_miners_failures_miner_getGET /public/miners/failures/{miner}Get all miners
SwaggerClient::NetApipublic_net_addrs_getGET /public/net/addrsNet Addrs
SwaggerClient::NetApipublic_net_peers_getGET /public/net/peersNet Peers
SwaggerClient::PinningApipinning_pins_getGET /pinning/pinsList all pin status objects
SwaggerClient::PinningApipinning_pins_pinid_deleteDELETE /pinning/pins/{pinid}Delete a pinned object
SwaggerClient::PinningApipinning_pins_pinid_getGET /pinning/pins/{pinid}Get a pin status object
SwaggerClient::PinningApipinning_pins_pinid_postPOST /pinning/pins/{pinid}Replace a pinned object
SwaggerClient::PinningApipinning_pins_postPOST /pinning/pinsAdd and pin object
SwaggerClient::PublicApiget_cid_getGET /get/{cid}Get Full Content by Cid
SwaggerClient::PublicApipublic_by_cid_cid_getGET /public/by-cid/{cid}Get Content by Cid
SwaggerClient::PublicApipublic_info_getGET /public/infoGet public node info
SwaggerClient::PublicApipublic_metrics_deals_on_chain_getGET /public/metrics/deals-on-chainGet deal metrics
SwaggerClient::PublicApipublic_miners_deals_miner_getGET /public/miners/deals/{miner}Get all miners deals
SwaggerClient::PublicApipublic_miners_failures_miner_getGET /public/miners/failures/{miner}Get all miners
SwaggerClient::PublicApipublic_miners_stats_miner_getGET /public/miners/stats/{miner}Get miner stats
SwaggerClient::PublicApipublic_net_addrs_getGET /public/net/addrsNet Addrs
SwaggerClient::PublicApipublic_net_peers_getGET /public/net/peersNet Peers
SwaggerClient::PublicApipublic_stats_getGET /public/statsPublic stats
SwaggerClient::UserApiuser_api_keys_getGET /user/api-keysGet API keys for a user
SwaggerClient::UserApiuser_api_keys_key_or_hash_deleteDELETE /user/api-keys/{key_or_hash}Revoke a User API Key.
SwaggerClient::UserApiuser_api_keys_postPOST /user/api-keysCreate API keys for a user
SwaggerClient::UserApiuser_export_getGET /user/exportExport user data
SwaggerClient::UserApiuser_stats_getGET /user/statsGet stats for the current user

Documentation for Models

Documentation for Authorization

bearerAuth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header